Pular para o conteúdo principal

Atualizar uma Tarifa

Use o seguinte endpoint para editar ou alterar uma tarifa:

PUT 'apisandbox-billing-api.delfinance.com.br/billing-accounts/:billingAccountId'

Headers

Nome                                         Descrição                                         
x-delfinance-api-keyRequired. API key

Corpo da requisição

NomeTypeDescription
bankAccountstringObrigatório. Conta bancária que será cobrada
feesobjectObjeto contendo informações sobre as tarifas
fees.transactionTypeIdenumQual tipo de transação será cobrada do seu cliente?
- 7 - TED enviado
- 8 - TED recebido
- 10 - Pix enviado
- 11 - Pix recebido
- 12 - Pix reembolsado recebido
- 13 - Pix reembolsado enviado
- 21 - TED reembolsado
- 43 - Reembolso administrativo de Pix
- 78 - Pix reembolsado enviado (desfazer transação)
- 133 - Pix debitado via MED RDR (desfazer transação)
- 9001 - Taxa mensal de custódia
- 9002 - Taxa mensal de API
fees.pricenumberValor a ser cobrado pela tarifa
fees.feeTypeenumTipo de valor à ser cobrado, Dominios:
fixed - Valor fixo
percentage - Porcentagem do valor
invoiceFrequencyobjectObjeto contendo informações da frequência de cobrança da tarifa
invoiceFrequency.categoryobjectA frequência em que o cliente será cobrado
- minute - A cobrança será ativada a cada minuto
- hour - A cobrança será ativada a cada hora
- day - A cobrança será ativada todos os dias
- week - A cobrança será ativada toda semana
- month - A cobrança será ativada todo mês
- year - A cobrança será ativada todo ano
invoiceFrequency.amountnumberValor que será cobrado em frequência definido
startDatedateData em que o cálculo da tarifa começa.
nextInvoiceAtdateData em que ocorrerá o primeiro pagamento, após esta data será estabelecido a partir da frequência

Examplo

{
"bankAccount": "123456",
"fees": [
{
"transactionTypeId": 10,
"price": 0.50,
"feeType": "fixed"
}
],
"invoiceFrequency": {
"category": "month",
"amount": 1
},
"startDate": "2023-01-01",
"nextInvoiceAt": "2023-02-01"
}

Resposta

Em caso de resposta bem-sucedida, você receberá um código de status 204